Skip to content

feat: support fake variadic when length 1 not included #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
alice-i-cecile merged 5 commits into from
Jan 15, 2026
Merged

feat: support fake variadic when length 1 not included #51

alice-i-cecile merged 5 commits into from
Jan 15, 2026

Conversation

@kingwingfly
Copy link
Contributor

@kingwingfly kingwingfly commented Dec 18, 2025

Objective

fixes #42

It also supports fake variadic when length 1 not included.

Solution

Instead of n == 1 to judge if it's the first one, I tried n == input.start.max(1). This ensure that the first tuples will always have attributes. So that length 1 does not need including.

let doc = LitStr::new(
                    &format!(
                        "This trait is implemented for tuples **{down}up to {up}** items long.",
                        down = if input.start != 0 {
                            format!("down to {} ", input.start)
                        } else {
                            "".to_string()
                        },
                        up = input.end
                    ),
                    Span2::call_site(),
                );

And omit document like down to 0.

Testing

I checked with this command:

RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --example all_tuples --no-deps --open

And

all_tuples!(
    #[doc(fake_variadic)]
    impl_tuple_foo,
    0,
    15,
    F
);

all_tuples!(
    #[doc(fake_variadic)]
    impl_tuple_foo,
    1,
    15,
    F
);

all_tuples!(
    #[doc(fake_variadic)]
    impl_tuple_foo,
    3,
    15,
    F
);

works as expected.

I also passed cargo test

@BenjaminBrienen
Copy link
Collaborator

BenjaminBrienen commented Dec 18, 2025

Can you include a screenshot of the generated documentation so that I can see it working?

@kingwingfly
Copy link
Contributor Author

kingwingfly commented Dec 18, 2025

Instead of n == 1 to judge if it's the first one, I tried n == input.start.max(1). This ensure that the first tuples will always have attributes. So that length 1 does not need including.

I just fixed some bugs... And the previous solution is wrong...

However, the new version is tested below:

all_tuples!(
    #[doc(fake_variadic)]
    impl_tuple_foo,
    0,
    5,
    F
);
image 
all_tuples!(
    #[doc(fake_variadic)]
    impl_tuple_foo,
    1,
    5,
    F
);
image 
all_tuples!(
    #[doc(fake_variadic)]
    impl_tuple_foo,
    3,
    5,
    F
);
image

cargo +nightly expand --example all_tuples (no implementation for (F, ))

image

RUSTFLAGS="--cfg docsrs" cargo +nightly expand --example all_tuples (only with --cfg docsrs, there's implementation for (F, ))

image 
all_tuples!(impl_tuple_foo, 1, 5, F);
image

alice-i-cecile
alice-i-cecile requested changes Dec 29, 2025
View reviewed changes
Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems quite reasonable and I'd like to fix this.

Can you add some tests to the library itself to ensure that this keeps working?

@kingwingfly
Copy link
Contributor Author

kingwingfly commented Dec 29, 2025

I do not know how to verify documentation generated by cargo-doc right now.

Anyway, I will try in a few days. (I'm preparing my final exam and am very busy at this moment.)

@kingwingfly
Copy link
Contributor Author

kingwingfly commented Jan 14, 2026

I've added tests.

Both cargo test and RUSTFLAGS="--cfg docsrs" cargo +nightly test should be executed.

However, I do not know how to change the ci...

BenjaminBrienen
BenjaminBrienen approved these changes Jan 15, 2026
View reviewed changes
Copy link
Collaborator

@BenjaminBrienen BenjaminBrienen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's some good stuff right there

@BenjaminBrienen
Copy link
Collaborator

BenjaminBrienen commented Jan 15, 2026

@alice-i-cecile Unicode 3.0 should be fine, right?

@alice-i-cecile
Copy link
Member

alice-i-cecile commented Jan 15, 2026

Yep that's fine.

@alice-i-cecile alice-i-cecile mentioned this pull request Jan 15, 2026
Open
@alice-i-cecile alice-i-cecile merged commit 5341aa1 into bevyengine:main Jan 15, 2026
26 of 27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@BenjaminBrienen BenjaminBrienen BenjaminBrienen approved these changes

@alice-i-cecile alice-i-cecile Awaiting requested review from alice-i-cecile

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Wrong tuple lengths being documented.

3 participants

@kingwingfly @BenjaminBrienen @alice-i-cecile